<!DOCTYPE html>
<html lang="en">
<head>
  <title>Vert.x Auth - Authentication and Authorisation - Vert.x</title>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta content="width=device-width, initial-scale=1.0" name="viewport">
  <meta content="Vert.x is a tool-kit for building reactive applications on the JVM." name="description">
  <link href="http://vertx.io/stylesheets/docs.css" media="screen" rel="stylesheet">
  <link href="http://vertx.io/stylesheets/font-awesome.min.css" media="screen" rel="stylesheet">
  <link href="http://vertx.io/javascripts/styles/rainbow.min.css" media="screen" rel="stylesheet">
  <!-- IE 6-8 support of HTML 5 elements -->
  <!--[if lt IE 9]>
  <script src="http://static.jboss.org/theme/js/libs/html5/pre3.6/html5.min.js"></script>
  <![endif]-->

  <link rel="apple-touch-icon" sizes="57x57" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-57x57.png">
  <link rel="apple-touch-icon" sizes="60x60" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-60x60.png">
  <link rel="apple-touch-icon" sizes="72x72" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-72x72.png">
  <link rel="apple-touch-icon" sizes="76x76" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-76x76.png">
  <link rel="apple-touch-icon" sizes="114x114" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-114x114.png">
  <link rel="apple-touch-icon" sizes="120x120" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-120x120.png">
  <link rel="apple-touch-icon" sizes="144x144" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-144x144.png">
  <link rel="apple-touch-icon" sizes="152x152" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-152x152.png">
  <link rel="apple-touch-icon" sizes="180x180" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-180x180.png">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-32x32.png" sizes="32x32">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/android-chrome-192x192.png" sizes="192x192">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-96x96.png" sizes="96x96">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-16x16.png" sizes="16x16">
  <link rel="manifest" href="http://vertx.io/assets/favicons/vertx-favicon-7/manifest.json">
  <link rel="mask-icon" href="http://vertx.io/assets/favicons/vertx-favicon-7/safari-pinned-tab.svg" color="#5bbad5">
  <meta name="msapplication-TileColor" content="#7d3194">
  <meta name="msapplication-TileImage" content="http://vertx.io/assets/favicons/vertx-favicon-7/mstile-144x144.png">
  <meta name="theme-color" content="#ffffff">

  <link href="http://fonts.googleapis.com/css?family=Ubuntu:400,500,700,400italic" rel="stylesheet" type="text/css">
  <link rel="alternate" type="application/rss+xml" title="RSS"
     href="http://vertx.io/feed.xml">
  <script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
    ga('create', 'UA-30144458-1', 'auto');
    ga('create', 'UA-71153120-1', 'auto', 'tracker');
    ga('send', 'pageview');
    ga('tracker.send', 'pageview');
  </script>
</head>
<body>

<a href="http://www.reactivemanifesto.org/" id="reactive-manifesto-banner">
  <img style="border: 0; position: fixed; right: 0; top:0; z-index: 9000"
    src="http://d379ifj7s9wntv.cloudfront.net/reactivemanifesto/images/ribbons/we-are-reactive-black-right.png">
</a>

<a id="skippy" class="sr-only sr-only-focusable" href="#content"><div class="container"><span class="skiplink-text">Skip to main content</span></div></a>

<header class="navbar navbar-default navbar-static-top" id="top" role="banner">
  <div class="container">
    <div class="navbar-header">
      <button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target="#vertx-navbar-collapse">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a href="http://vertx.io/" class="navbar-brand"><img alt="Brand" src="http://vertx.io/assets/logo-sm.png"></a>
    </div>
    <nav class="collapse navbar-collapse" id="vertx-navbar-collapse">
      <ul class="nav navbar-nav navbar-right">
        <li><a href="http://vertx.io/download/">Download</a></li>
        <li><a href="http://vertx.io/docs/">Documentation</a></li>
        <li><a href="https://github.com/vert-x3/wiki/wiki">Wiki</a></li>
        <li><a href="http://vertx.io/community/">Community</a></li>
        <li><a href="http://vertx.io/materials/">Materials</a></li>
        <li><a href="http://vertx.io/blog/">Blog</a></li>        
      </ul>
    </nav>
  </div>
</header>



  <div class="page-header" id="content">
    <div class="container">
      <div class="row">
        <div class="col-sm-12">
          <h1>Vert.x Auth - Authentication and Authorisation</h1>
          
        </div>
      </div>
    </div>
  </div>




<div id="content">
  <div class="container docs-content">
    <div class="row">
      <div class="col-sm-12 col-md-push-9 col-md-3 hidden-xs hidden-sm">
        <div id="sidebar" data-spy="affix">
          <ul class="sectlevel1">
<li><a href="#_basic_concepts">Basic concepts</a></li>
<li><a href="#_authentication">Authentication</a></li>
<li><a href="#_authorisation">Authorisation</a>
<ul class="sectlevel2">
<li><a href="#_caching_authorities">Caching authorities</a></li>
<li><a href="#_the_user_principal">The User Principal</a></li>
</ul>
</li>
<li><a href="#_creating_your_own_auth_implementation">Creating your own auth implementation</a></li>
</ul>
        </div>
      </div>
      <div class="col-sm-12 col-md-pull-3 col-md-9">
        <div class="toc hidden-md hidden-lg">
          <h2>Table of Contents</h2>
          <ul class="sectlevel1">
<li><a href="#_basic_concepts">Basic concepts</a></li>
<li><a href="#_authentication">Authentication</a></li>
<li><a href="#_authorisation">Authorisation</a>
<ul class="sectlevel2">
<li><a href="#_caching_authorities">Caching authorities</a></li>
<li><a href="#_the_user_principal">The User Principal</a></li>
</ul>
</li>
<li><a href="#_creating_your_own_auth_implementation">Creating your own auth implementation</a></li>
</ul>
        </div>
        <div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>This Vert.x component provides interfaces for authentication and authorisation that can be used from
your Vert.x applications and can be backed by different providers.</p>
</div>
<div class="paragraph">
<p>Vert.x auth is also used by vertx-web to handle its authentication and authorisation.</p>
</div>
<div class="paragraph">
<p>To use this project, add the following dependency to the <em>dependencies</em> section of your build descriptor:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Maven (in your <code>pom.xml</code>):</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml">&lt;dependency&gt;
  &lt;groupId&gt;io.vertx&lt;/groupId&gt;
  &lt;artifactId&gt;vertx-auth-common&lt;/artifactId&gt;
  &lt;version&gt;3.3.3&lt;/version&gt;
&lt;/dependency&gt;</code></pre>
</div>
</div>
<div class="ulist">
<ul>
<li>
<p>Gradle (in your <code>build.gradle</code> file):</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-groovy" data-lang="groovy">compile 'io.vertx:vertx-auth-common:3.3.3'</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_basic_concepts">Basic concepts</h2>
<div class="sectionbody">
<div class="paragraph">
<p><em>Authentication</em> means verifying the identity of a user.</p>
</div>
<div class="paragraph">
<p><em>Authorisation</em> means verifying a user has an authority.</p>
</div>
<div class="paragraph">
<p>What the authority means is determined by the particular implementation and we don&#8217;t mandate any particular model,
e.g. a permissions/roles model, to keep things very flexible.</p>
</div>
<div class="paragraph">
<p>For some implementations an authority might represent a permission, for example the authority to access all printers,
or a specific printer. Other implementations must support roles too, and will often represent this by prefixing
the authority with something like <code>role:</code>, e.g. <code>role:admin</code>. Another implementation might have a completely
different model of representing authorities.</p>
</div>
<div class="paragraph">
<p>To find out what a particular auth provider expects, consult the documentation for that auth provider..</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_authentication">Authentication</h2>
<div class="sectionbody">
<div class="paragraph">
<p>To authenticate a user you use <code><a href="../../jsdoc/module-vertx-auth-common-js_auth_provider-AuthProvider.html#authenticate">authenticate</a></code>.</p>
</div>
<div class="paragraph">
<p>The first argument is a JSON object which contains authentication information. What this actually contains depends
on the specific implementation; for a simple username/password based authentication it might contain something like:</p>
</div>
<div class="listingblock">
<div class="content">
<pre>{
  "username": "tim"
  "password": "mypassword"
}</pre>
</div>
</div>
<div class="paragraph">
<p>For an implementation based on JWT token or OAuth bearer tokens it might contain the token information.</p>
</div>
<div class="paragraph">
<p>Authentication occurs asynchronously and the result is passed to the user on the result handler that was provided in
the call. The async result contains an instance of <code><a href="../../jsdoc/module-vertx-auth-common-js_user-User.html">User</a></code> which represents the authenticated
user and contains operations which allow the user to be authorised.</p>
</div>
<div class="paragraph">
<p>Here&#8217;s an example of authenticating a user using a simple username/password implementation:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-java" data-lang="java">var authInfo = {
  "username" : "tim",
  "password" : "mypassword"
};

authProvider.authenticate(authInfo, function (res, res_err) {
  if (res_err == null) {

    var user = res;

    console.log("User " + user.principal() + " is now authenticated");

  } else {
    res_err.printStackTrace();
  }
});</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_authorisation">Authorisation</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Once you have an <code><a href="../../jsdoc/module-vertx-auth-common-js_user-User.html">User</a></code> instance you can call methods on it to authorise it.</p>
</div>
<div class="paragraph">
<p>to check if a user has a specific authority you use <code><a href="../../jsdoc/module-vertx-auth-common-js_user-User.html#isAuthorised">isAuthorised</a></code>.</p>
</div>
<div class="paragraph">
<p>The results of all the above are provided asynchronously in the handler.</p>
</div>
<div class="paragraph">
<p>Here&#8217;s an example of authorising a user:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-java" data-lang="java">user.isAuthorised("printers:printer1234", function (res, res_err) {
  if (res_err == null) {

    var hasAuthority = res;

    if (hasAuthority) {
      console.log("User has the authority");
    } else {
      console.log("User does not have the authority");
    }

  } else {
    res_err.printStackTrace();
  }
});</code></pre>
</div>
</div>
<div class="paragraph">
<p>And another example of authorising in a roles based model which uses <code>role:</code> as a prefix.</p>
</div>
<div class="paragraph">
<p>Please note, as discussed above how the authority string is interpreted is completely determined by the underlying
implementation and Vert.x makes no assumptions here.</p>
</div>
<div class="sect2">
<h3 id="_caching_authorities">Caching authorities</h3>
<div class="paragraph">
<p>The user object will cache any authorities so subsequently calls to check if it has the same authorities will result
in the underlying provider being called.</p>
</div>
<div class="paragraph">
<p>In order to clear the internal cache you can use <code><a href="../../jsdoc/module-vertx-auth-common-js_user-User.html#clearCache">clearCache</a></code>.</p>
</div>
</div>
<div class="sect2">
<h3 id="_the_user_principal">The User Principal</h3>
<div class="paragraph">
<p>You can get the Principal corresponding to the authenticated user with <code><a href="../../jsdoc/module-vertx-auth-common-js_user-User.html#principal">principal</a></code>.</p>
</div>
<div class="paragraph">
<p>What this returns depends on the underlying implementation.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_creating_your_own_auth_implementation">Creating your own auth implementation</h2>
<div class="sectionbody">
<div class="paragraph">
<p>If you wish to create your own auth provider you should implement the <code><a href="../../jsdoc/module-vertx-auth-common-js_auth_provider-AuthProvider.html">AuthProvider</a></code> interface.</p>
</div>
<div class="paragraph">
<p>We provide an abstract implementation of user called <code>AbstractUser</code> which you can subclass
to make your user implementation. This contains the caching logic so you don&#8217;t have to implement that yourself.</p>
</div>
<div class="paragraph">
<p>If you wish your user objects to be clusterable you should make sure they implement <code>ClusterSerializable</code>.
&lt;a href="mailto:julien@julienviet.com"&gt;Julien Viet&lt;/a&gt;&lt;a href="http://tfox.org"&gt;Tim Fox&lt;/a&gt;</p>
</div>
</div>
</div>

        

        
          <div id="footer">
            <div id="footer-text">
              
                Last updated 2016-09-12 08:38:04 CEST
              
              
            </div>
          </div>
        
      </div>
    </div>
  </div>
</div>

<footer>
  <div class="container">
    <div class="row">
      <div class="col-xs-6 col-sm-3 col-md-3 col-lg-2">
        <h2>Vert.x</h2>
        <ul class="list-unstyled">
          <li><a href="http://vertx.io/">Home</a></li>
          <li><a href="http://vertx.io/download/">Download</a></li>
          <li><a href="http://vertx.io/docs/">Documentation</a></li>
          <li><a href="https://github.com/vert-x3/wiki/wiki">Wiki</a></li>
          <li><a href="http://vertx.io/blog/">Blog</a></li>
          <li><a href="http://vertx.io/vertx2/" class="vertx-2-link">Vert.x 2</a></li>
        </ul>
      </div>
      <div class="col-xs-6 col-sm-3 col-md-3 col-lg-2">
        <h2>Community</h2>
        <ul class="list-unstyled">
          <li><a href="http://vertx.io/community/">Help &amp; Contributors</a></li>
          <li><a href="http://vertx.io/materials/">Learning materials</a></li>
          <li><a href="https://groups.google.com/forum/?fromgroups#!forum/vertx">User Group</a></li>
          <li><a href="https://groups.google.com/forum/?fromgroups#!forum/vertx-dev">Developer Group</a></li>
        </ul>
      </div>

      <div class="col-xs-12 col-sm-6 col-lg-offset-2 col-md-6 copyright">
        <p>Vert.x is open source and dual licensed under the <a href="https://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License 1.0</a> and <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache License 2.0</a>.</p>
        <p>This website is licensed under the <a href="http://creativecommons.org/licenses/by-sa/3.0/">CC BY-SA 3.0 License</a>.<br>
        Design by <a href="http://www.michel-kraemer.com">Michel Kr&auml;mer</a>. <a href="http://www.entypo.com">Entypo pictograms</a> by Daniel Bruce.</p>
        <div class="row">
          <div class="col-xs-12 col-lg-offset-1 col-md-5">
            <a href="http://eclipse.org">
            <img class="logo eclipse-logo" src="http://vertx.io/assets/eclipse_logo_grey_small.png" width="204" height="48">
            </a>
          </div>
          <div class="col-xs-12 col-md-offset-2 col-lg-offset-0 col-md-5">
            <a href="http://cloudbees.com">
            <img class="logo cloudbees-logo" src="http://vertx.io/assets/Button-Built-on-CB-1-grey.png" width="180" height="48">
           </a>
          </div>
          <div class="col-xs-12 col-md-offset-2 col-lg-offset-1 col-md-5 jprofiler">
            <a href="http://www.ej-technologies.com/products/jprofiler/overview.html"
            style="text-decoration:none">
            <img class="logo jprofiler-logo" src="http://vertx.io/assets/jprofiler-logo.png" width="48" height="48"><span class="jprofiler-logo">&nbsp; JPROFILER</span>
            </a>
          </div>
        </div>
      </div>
    </div>
  </div>
</footer>

<script src="http://static.jboss.org/theme/js/libs/jquery/jquery-1.9.1.min.js"></script>
<script src="http://vertx.io/javascripts/bootstrap.min.js"></script>
<script src="http://vertx.io/javascripts/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>



<script src="http://vertx.io/javascripts/sidebar.js"></script>


</body>
</html>
